<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IBustEngineDesc</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
<link rel="home" href="index.html" title="IBust Reference Manual">
<link rel="up" href="ch03.html" title="Input method engine">
<link rel="prev" href="IBustEngine.html" title="IBustEngine">
<link rel="next" href="ibust-IBustEngineSimple.html" title="IBustEngineSimple">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="IBustEngine.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">IBust Reference Manual</th>
<td><a accesskey="n" href="ibust-IBustEngineSimple.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IBustEngineDesc.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#IBustEngineDesc.description" class="shortcut">Description</a>
                   | 
                  <a href="#IBustEngineDesc.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#IBustEngineDesc.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="IBustEngineDesc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IBustEngineDesc.top_of_page"></a>IBustEngineDesc</span></h2>
<p>IBustEngineDesc — Input method engine description data.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="IBustEngineDesc.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="IBustEngineDesc.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="IBustEngineDesc.html#IBustEngineDesc-struct" title="struct IBustEngineDesc">IBustEngineDesc</a>;
struct              <a class="link" href="IBustEngineDesc.html#IBustEngineDescClass" title="struct IBustEngineDescClass">IBustEngineDescClass</a>;
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-author" title="ibust_engine_desc_get_author ()">ibust_engine_desc_get_author</a>         (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-description" title="ibust_engine_desc_get_description ()">ibust_engine_desc_get_description</a>    (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-hotkeys" title="ibust_engine_desc_get_hotkeys ()">ibust_engine_desc_get_hotkeys</a>        (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-icon" title="ibust_engine_desc_get_icon ()">ibust_engine_desc_get_icon</a>           (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-language" title="ibust_engine_desc_get_language ()">ibust_engine_desc_get_language</a>       (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-layout" title="ibust_engine_desc_get_layout ()">ibust_engine_desc_get_layout</a>         (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-layout-option" title="ibust_engine_desc_get_layout_option ()">ibust_engine_desc_get_layout_option</a>  (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-layout-variant" title="ibust_engine_desc_get_layout_variant ()">ibust_engine_desc_get_layout_variant</a> (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-license" title="ibust_engine_desc_get_license ()">ibust_engine_desc_get_license</a>        (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-longname" title="ibust_engine_desc_get_longname ()">ibust_engine_desc_get_longname</a>       (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-name" title="ibust_engine_desc_get_name ()">ibust_engine_desc_get_name</a>           (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
<span class="returnvalue">guint</span>               <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-rank" title="ibust_engine_desc_get_rank ()">ibust_engine_desc_get_rank</a>           (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-setup" title="ibust_engine_desc_get_setup ()">ibust_engine_desc_get_setup</a>          (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-symbol" title="ibust_engine_desc_get_symbol ()">ibust_engine_desc_get_symbol</a>         (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-get-version" title="ibust_engine_desc_get_version ()">ibust_engine_desc_get_version</a>        (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);
<a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="returnvalue">IBustEngineDesc</span></a> *    <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-new" title="ibust_engine_desc_new ()">ibust_engine_desc_new</a>                (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *longname</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *language</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *license</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *author</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *icon</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *layout</code></em>);
<a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="returnvalue">IBustEngineDesc</span></a> *    <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-new-from-xml-node" title="ibust_engine_desc_new_from_xml_node ()">ibust_engine_desc_new_from_xml_node</a>  (<em class="parameter"><code><a class="link" href="ibust-ibustxml.html#XMLNode" title="XMLNode"><span class="type">XMLNode</span></a> *node</code></em>);
<a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="returnvalue">IBustEngineDesc</span></a> *    <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-new-varargs" title="ibust_engine_desc_new_varargs ()">ibust_engine_desc_new_varargs</a>        (<em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-output" title="ibust_engine_desc_output ()">ibust_engine_desc_output</a>             (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>,
                                                         <em class="parameter"><code><span class="type">GString</span> *output</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> indent</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="IBustEngineDesc.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----<a class="link" href="IBustObject.html" title="IBustObject">IBustObject</a>
               +----<a class="link" href="IBustSerializable.html" title="IBustSerializable">IBustSerializable</a>
                     +----IBustEngineDesc
</pre>
</div>
<div class="refsect1">
<a name="IBustEngineDesc.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--author" title='The "author" property'>author</a>"                   <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--description" title='The "description" property'>description</a>"              <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--hotkeys" title='The "hotkeys" property'>hotkeys</a>"                  <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--icon" title='The "icon" property'>icon</a>"                     <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--language" title='The "language" property'>language</a>"                 <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--layout" title='The "layout" property'>layout</a>"                   <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--layout-option" title='The "layout-option" property'>layout-option</a>"            <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--layout-variant" title='The "layout-variant" property'>layout-variant</a>"           <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--license" title='The "license" property'>license</a>"                  <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--longname" title='The "longname" property'>longname</a>"                 <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--name" title='The "name" property'>name</a>"                     <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--rank" title='The "rank" property'>rank</a>"                     <span class="type">guint</span>                 : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--setup" title='The "setup" property'>setup</a>"                    <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--symbol" title='The "symbol" property'>symbol</a>"                   <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="IBustEngineDesc.html#IBustEngineDesc--version" title='The "version" property'>version</a>"                  <span class="type">gchar</span>*                : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="IBustEngineDesc.description"></a><h2>Description</h2>
<p>
An IBustEngineDesc stores description data of IBustEngine.
The description data can either be passed to <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-new" title="ibust_engine_desc_new ()"><code class="function">ibust_engine_desc_new()</code></a>,
or loaded from an XML node through <a class="link" href="IBustEngineDesc.html#ibust-engine-desc-new-from-xml-node" title="ibust_engine_desc_new_from_xml_node ()"><code class="function">ibust_engine_desc_new_from_xml_node()</code></a>
to construct IBustEngineDesc.
</p>
<p>
However, the recommended way to load engine description data is
using <a class="link" href="IBustComponent.html#ibust-component-new-from-file" title="ibust_component_new_from_file ()"><code class="function">ibust_component_new_from_file()</code></a> to load a component file,
which also includes engine description data.
</p>
<p>
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBustComponent.html" title="IBustComponent"><span class="type">IBustComponent</span></a>, <a class="link" href="IBustEngine.html" title="IBustEngine"><span class="type">IBustEngine</span></a>
</p>
</div>
<div class="refsect1">
<a name="IBustEngineDesc.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="IBustEngineDesc-struct"></a><h3>struct IBustEngineDesc</h3>
<pre class="programlisting">struct IBustEngineDesc;</pre>
<p>
Input method engine description data.
You can get extended values with g_object_get_properties.
name: Name of the engine.
longname: Long name of the input method engine.
description: Input method engine description.
language: Language (e.g. zh, jp) supported by this input method engine.
license: License of the input method engine.
author: Author of the input method engine.
icon: Icon file of this engine.
layout: Keyboard layout
layout_variant: Keyboard variant
layout_option: Keyboard option
rank: Preference rank among engines, the highest ranked IME will put in
the front.
hotkeys: One or more hotkeys for switching to this engine, separated by
 semi-colon.
setup: Exec lists of the engine setup command.
version: Version number of the input method engine.
</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDescClass"></a><h3>struct IBustEngineDescClass</h3>
<pre class="programlisting">struct IBustEngineDescClass {
    IBustSerializableClass parent;
    /* class members */
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-author"></a><h3>ibust_engine_desc_get_author ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_author         (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the author property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>author property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-description"></a><h3>ibust_engine_desc_get_description ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_description    (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the description property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>description property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-hotkeys"></a><h3>ibust_engine_desc_get_hotkeys ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_hotkeys        (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the hotkeys property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>hotkeys property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-icon"></a><h3>ibust_engine_desc_get_icon ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_icon           (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the icon property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>icon property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-language"></a><h3>ibust_engine_desc_get_language ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_language       (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the language property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>language property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-layout"></a><h3>ibust_engine_desc_get_layout ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_layout         (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the layout property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>layout property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-layout-option"></a><h3>ibust_engine_desc_get_layout_option ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_layout_option  (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the keyboard option property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>keyboard option property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-layout-variant"></a><h3>ibust_engine_desc_get_layout_variant ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_layout_variant (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the keyboard variant property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>keyboard variant property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-license"></a><h3>ibust_engine_desc_get_license ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_license        (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the license property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>license property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-longname"></a><h3>ibust_engine_desc_get_longname ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_longname       (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the longname property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>longname property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-name"></a><h3>ibust_engine_desc_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_name           (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the name property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>name property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-rank"></a><h3>ibust_engine_desc_get_rank ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>               ibust_engine_desc_get_rank           (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the rank property in IBustEngineDesc.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>rank property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-setup"></a><h3>ibust_engine_desc_get_setup ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_setup          (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the setup property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>setup property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-symbol"></a><h3>ibust_engine_desc_get_symbol ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_symbol         (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the symbol property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>symbol property in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-get-version"></a><h3>ibust_engine_desc_get_version ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       ibust_engine_desc_get_version        (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>);</pre>
<p>
Return the version property in IBustEngineDesc. It should not be freed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>version in IBustEngineDesc</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-new"></a><h3>ibust_engine_desc_new ()</h3>
<pre class="programlisting"><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="returnvalue">IBustEngineDesc</span></a> *    ibust_engine_desc_new                (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *longname</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *language</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *license</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *author</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *icon</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *layout</code></em>);</pre>
<p>
New a IBustEngineDesc.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Name of the engine.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longname</code></em> :</span></p></td>
<td>Long name of the input method engine.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td>Input method engine description.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>language</code></em> :</span></p></td>
<td>Language (e.g. zh, jp) supported by this input method engine.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>license</code></em> :</span></p></td>
<td>License of the input method engine.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>author</code></em> :</span></p></td>
<td>Author of the input method engine.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>Icon file of this engine.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
<td>Keyboard layout</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated IBustEngineDesc.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-new-from-xml-node"></a><h3>ibust_engine_desc_new_from_xml_node ()</h3>
<pre class="programlisting"><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="returnvalue">IBustEngineDesc</span></a> *    ibust_engine_desc_new_from_xml_node  (<em class="parameter"><code><a class="link" href="ibust-ibustxml.html#XMLNode" title="XMLNode"><span class="type">XMLNode</span></a> *node</code></em>);</pre>
<p>
New a IBustEngineDesc from an XML node.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>This function is called by <a class="link" href="IBustComponent.html#ibust-component-new-from-file" title="ibust_component_new_from_file ()"><code class="function">ibust_component_new_from_file()</code></a>,
 so developers normally do not need to call it directly.
</p>
</div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
<td>An XML node</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated IBustEngineDesc that contains description from
<em class="parameter"><code>node</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-new-varargs"></a><h3>ibust_engine_desc_new_varargs ()</h3>
<pre class="programlisting"><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="returnvalue">IBustEngineDesc</span></a> *    ibust_engine_desc_new_varargs        (<em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<p>
New a IBustEngineDesc.
<a class="link" href="IBustEngineDesc.html#ibust-engine-desc-new-varargs" title="ibust_engine_desc_new_varargs ()"><code class="function">ibust_engine_desc_new_varargs()</code></a> supports the va_list format.
name property is required. e.g.
ibust_engine_desc_new_varargs("name", "ibust-foo", "language", "us", NULL)
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
<td>Name of the first property.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-engine-desc-output"></a><h3>ibust_engine_desc_output ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_engine_desc_output             (<em class="parameter"><code><a class="link" href="IBustEngineDesc.html" title="IBustEngineDesc"><span class="type">IBustEngineDesc</span></a> *info</code></em>,
                                                         <em class="parameter"><code><span class="type">GString</span> *output</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> indent</code></em>);</pre>
<p>
Output XML-formatted input method engine description.
The result will be append to GString specified in <em class="parameter"><code>output</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>An IBustEngineDesc</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
<td>XML-formatted Input method engine description.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>indent</code></em> :</span></p></td>
<td>Number of indent (showed as 4 spaces).</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="IBustEngineDesc.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="IBustEngineDesc--author"></a><h3>The <code class="literal">"author"</code> property</h3>
<pre class="programlisting">  "author"                   <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The author of engine description
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--description"></a><h3>The <code class="literal">"description"</code> property</h3>
<pre class="programlisting">  "description"              <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The description of engine description
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--hotkeys"></a><h3>The <code class="literal">"hotkeys"</code> property</h3>
<pre class="programlisting">  "hotkeys"                  <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The hotkeys of engine description
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--icon"></a><h3>The <code class="literal">"icon"</code> property</h3>
<pre class="programlisting">  "icon"                     <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The icon of engine description
</p>
<p>Default value: "ibust-engine"</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--language"></a><h3>The <code class="literal">"language"</code> property</h3>
<pre class="programlisting">  "language"                 <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The language of engine description
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--layout"></a><h3>The <code class="literal">"layout"</code> property</h3>
<pre class="programlisting">  "layout"                   <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The layout of engine description
</p>
<p>Default value: "us"</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--layout-option"></a><h3>The <code class="literal">"layout-option"</code> property</h3>
<pre class="programlisting">  "layout-option"            <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The keyboard option of engine description
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--layout-variant"></a><h3>The <code class="literal">"layout-variant"</code> property</h3>
<pre class="programlisting">  "layout-variant"           <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The keyboard variant of engine description
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--license"></a><h3>The <code class="literal">"license"</code> property</h3>
<pre class="programlisting">  "license"                  <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The license of engine description
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--longname"></a><h3>The <code class="literal">"longname"</code> property</h3>
<pre class="programlisting">  "longname"                 <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The longname of engine description
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting">  "name"                     <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The name of engine description
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--rank"></a><h3>The <code class="literal">"rank"</code> property</h3>
<pre class="programlisting">  "rank"                     <span class="type">guint</span>                 : Read / Write / Construct Only</pre>
<p>
The rank of engine description
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--setup"></a><h3>The <code class="literal">"setup"</code> property</h3>
<pre class="programlisting">  "setup"                    <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The exec lists of the engine setup command
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--symbol"></a><h3>The <code class="literal">"symbol"</code> property</h3>
<pre class="programlisting">  "symbol"                   <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The symbol chars of engine description instead of icon image
</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustEngineDesc--version"></a><h3>The <code class="literal">"version"</code> property</h3>
<pre class="programlisting">  "version"                  <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The version number of engine description
</p>
<p>Default value: ""</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>